/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.net;

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.Proxy;
import java.net.Socket;
import java.net.UnknownHostException;

import javax.net.SocketFactory;

import org.apache.hadoop.hbase.conf.Configurable;
import org.apache.hadoop.hbase.conf.Configuration;

/**
 * Specialized SocketFactory to create sockets with a SOCKS proxy
 */
public class SocksSocketFactory extends SocketFactory implements Configurable {

	private Configuration conf;

	private Proxy proxy;

	/**
	 * Default empty constructor (for use with the reflection API).
	 */
	public SocksSocketFactory() {
		this.proxy = Proxy.NO_PROXY;
	}

	/**
	 * Constructor with a supplied Proxy
	 * 
	 * @param proxy the proxy to use to create sockets
	 */
	public SocksSocketFactory(Proxy proxy) {
		this.proxy = proxy;
	}

	/* @inheritDoc */
	@Override
	public Socket createSocket() throws IOException {

		return new Socket(proxy);
	}

	/* @inheritDoc */
	@Override
	public Socket createSocket(InetAddress addr, int port) throws IOException {

		Socket socket = createSocket();
		socket.connect(new InetSocketAddress(addr, port));
		return socket;
	}

	/* @inheritDoc */
	@Override
	public Socket createSocket(InetAddress addr, int port, InetAddress localHostAddr, int localPort) throws IOException {

		Socket socket = createSocket();
		socket.bind(new InetSocketAddress(localHostAddr, localPort));
		socket.connect(new InetSocketAddress(addr, port));
		return socket;
	}

	/* @inheritDoc */
	@Override
	public Socket createSocket(String host, int port) throws IOException, UnknownHostException {

		Socket socket = createSocket();
		socket.connect(new InetSocketAddress(host, port));
		return socket;
	}

	/* @inheritDoc */
	@Override
	public Socket createSocket(String host, int port, InetAddress localHostAddr, int localPort) throws IOException,
			UnknownHostException {

		Socket socket = createSocket();
		socket.bind(new InetSocketAddress(localHostAddr, localPort));
		socket.connect(new InetSocketAddress(host, port));
		return socket;
	}

	/* @inheritDoc */
	@Override
	public int hashCode() {
		return proxy.hashCode();
	}

	/* @inheritDoc */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (!(obj instanceof SocksSocketFactory))
			return false;
		final SocksSocketFactory other = (SocksSocketFactory) obj;
		if (proxy == null) {
			if (other.proxy != null)
				return false;
		} else if (!proxy.equals(other.proxy))
			return false;
		return true;
	}

	/* @inheritDoc */
	public Configuration getConf() {
		return this.conf;
	}

	/* @inheritDoc */
	public void setConf(Configuration conf) {
		this.conf = conf;
		String proxyStr = conf.get("hadoop.socks.server");
		if ((proxyStr != null) && (proxyStr.length() > 0)) {
			setProxy(proxyStr);
		}
	}

	/**
	 * Set the proxy of this socket factory as described in the string
	 * parameter
	 * 
	 * @param proxyStr the proxy address using the format "host:port"
	 */
	private void setProxy(String proxyStr) {
		String[] strs = proxyStr.split(":", 2);
		if (strs.length != 2)
			throw new RuntimeException("Bad SOCKS proxy parameter: " + proxyStr);
		String host = strs[0];
		int port = Integer.parseInt(strs[1]);
		this.proxy = new Proxy(Proxy.Type.SOCKS, InetSocketAddress.createUnresolved(host, port));
	}
}
